<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.jxpath.xml;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.InputStream;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.net.URL;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.HashMap;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.jxpath.Container;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.jxpath.JXPathException;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    /**<a name="line.27"></a>
<FONT color="green">028</FONT>     * An XML document container reads and parses XML only when it is<a name="line.28"></a>
<FONT color="green">029</FONT>     * accessed.  JXPath traverses Containers transparently -<a name="line.29"></a>
<FONT color="green">030</FONT>     * you use the same paths to access objects in containers as you<a name="line.30"></a>
<FONT color="green">031</FONT>     * do to access those objects directly.  You can create<a name="line.31"></a>
<FONT color="green">032</FONT>     * XMLDocumentContainers for various XML documents that may or<a name="line.32"></a>
<FONT color="green">033</FONT>     * may not be accessed by XPaths.  If they are, they will be automatically<a name="line.33"></a>
<FONT color="green">034</FONT>     * read, parsed and traversed. If they are not - they won't be<a name="line.34"></a>
<FONT color="green">035</FONT>     * read at all.<a name="line.35"></a>
<FONT color="green">036</FONT>     *<a name="line.36"></a>
<FONT color="green">037</FONT>     * @author Dmitri Plotnikov<a name="line.37"></a>
<FONT color="green">038</FONT>     * @version $Revision: 668329 $ $Date: 2008-06-16 16:59:48 -0500 (Mon, 16 Jun 2008) $<a name="line.38"></a>
<FONT color="green">039</FONT>     */<a name="line.39"></a>
<FONT color="green">040</FONT>    public class DocumentContainer extends XMLParser2 implements Container {<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>        /** DOM constant */<a name="line.42"></a>
<FONT color="green">043</FONT>        public static final String MODEL_DOM = "DOM";<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>        /** JDOM constant */<a name="line.45"></a>
<FONT color="green">046</FONT>        public static final String MODEL_JDOM = "JDOM";<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        private static final long serialVersionUID = -8713290334113427066L;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        private static HashMap parserClasses = new HashMap();<a name="line.50"></a>
<FONT color="green">051</FONT>        static {<a name="line.51"></a>
<FONT color="green">052</FONT>            parserClasses.put(MODEL_DOM,<a name="line.52"></a>
<FONT color="green">053</FONT>                              "org.apache.commons.jxpath.xml.DOMParser");<a name="line.53"></a>
<FONT color="green">054</FONT>            parserClasses.put(MODEL_JDOM,<a name="line.54"></a>
<FONT color="green">055</FONT>                              "org.apache.commons.jxpath.xml.JDOMParser");<a name="line.55"></a>
<FONT color="green">056</FONT>        }<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>        private static HashMap parsers = new HashMap();<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>        private Object document;<a name="line.60"></a>
<FONT color="green">061</FONT>        private URL xmlURL;<a name="line.61"></a>
<FONT color="green">062</FONT>        private String model;<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /**<a name="line.64"></a>
<FONT color="green">065</FONT>         * Add an XML parser.  Parsers for the models "DOM" and "JDOM" are<a name="line.65"></a>
<FONT color="green">066</FONT>         * pre-registered.<a name="line.66"></a>
<FONT color="green">067</FONT>         * @param model model name<a name="line.67"></a>
<FONT color="green">068</FONT>         * @param parser parser<a name="line.68"></a>
<FONT color="green">069</FONT>         */<a name="line.69"></a>
<FONT color="green">070</FONT>        public static void registerXMLParser(String model, XMLParser parser) {<a name="line.70"></a>
<FONT color="green">071</FONT>            parsers.put(model, parser);<a name="line.71"></a>
<FONT color="green">072</FONT>        }<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>        /**<a name="line.74"></a>
<FONT color="green">075</FONT>         * Add a class of a custom XML parser.<a name="line.75"></a>
<FONT color="green">076</FONT>         * Parsers for the models "DOM" and "JDOM" are pre-registered.<a name="line.76"></a>
<FONT color="green">077</FONT>         * @param model model name<a name="line.77"></a>
<FONT color="green">078</FONT>         * @param parserClassName parser classname<a name="line.78"></a>
<FONT color="green">079</FONT>         */<a name="line.79"></a>
<FONT color="green">080</FONT>        public static void registerXMLParser(String model, String parserClassName) {<a name="line.80"></a>
<FONT color="green">081</FONT>            parserClasses.put(model, parserClassName);<a name="line.81"></a>
<FONT color="green">082</FONT>        }<a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>        /**<a name="line.84"></a>
<FONT color="green">085</FONT>         * Use this constructor if the desired model is DOM.<a name="line.85"></a>
<FONT color="green">086</FONT>         *<a name="line.86"></a>
<FONT color="green">087</FONT>         * @param xmlURL is a URL for an XML file.<a name="line.87"></a>
<FONT color="green">088</FONT>         * Use getClass().getResource(resourceName) to load XML from a<a name="line.88"></a>
<FONT color="green">089</FONT>         * resource file.<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        public DocumentContainer(URL xmlURL) {<a name="line.91"></a>
<FONT color="green">092</FONT>            this(xmlURL, MODEL_DOM);<a name="line.92"></a>
<FONT color="green">093</FONT>        }<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>        /**<a name="line.95"></a>
<FONT color="green">096</FONT>         * Construct a new DocumentContainer.<a name="line.96"></a>
<FONT color="green">097</FONT>         * @param xmlURL is a URL for an XML file. Use getClass().getResource<a name="line.97"></a>
<FONT color="green">098</FONT>         *               (resourceName) to load XML from a resource file.<a name="line.98"></a>
<FONT color="green">099</FONT>         *<a name="line.99"></a>
<FONT color="green">100</FONT>         * @param model is one of the MODEL_* constants defined in this class. It<a name="line.100"></a>
<FONT color="green">101</FONT>         *              determines which parser should be used to load the XML.<a name="line.101"></a>
<FONT color="green">102</FONT>         */<a name="line.102"></a>
<FONT color="green">103</FONT>        public DocumentContainer(URL xmlURL, String model) {<a name="line.103"></a>
<FONT color="green">104</FONT>            this.xmlURL = xmlURL;<a name="line.104"></a>
<FONT color="green">105</FONT>            if (xmlURL == null) {<a name="line.105"></a>
<FONT color="green">106</FONT>                throw new JXPathException("XML URL is null");<a name="line.106"></a>
<FONT color="green">107</FONT>            }<a name="line.107"></a>
<FONT color="green">108</FONT>            this.model = model;<a name="line.108"></a>
<FONT color="green">109</FONT>        }<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        /**<a name="line.111"></a>
<FONT color="green">112</FONT>         * Reads XML, caches it internally and returns the Document.<a name="line.112"></a>
<FONT color="green">113</FONT>         * @return Object<a name="line.113"></a>
<FONT color="green">114</FONT>         */<a name="line.114"></a>
<FONT color="green">115</FONT>        public Object getValue() {<a name="line.115"></a>
<FONT color="green">116</FONT>            if (document == null) {<a name="line.116"></a>
<FONT color="green">117</FONT>                try {<a name="line.117"></a>
<FONT color="green">118</FONT>                    InputStream stream = null;<a name="line.118"></a>
<FONT color="green">119</FONT>                    try {<a name="line.119"></a>
<FONT color="green">120</FONT>                        if (xmlURL != null) {<a name="line.120"></a>
<FONT color="green">121</FONT>                            stream = xmlURL.openStream();<a name="line.121"></a>
<FONT color="green">122</FONT>                        }<a name="line.122"></a>
<FONT color="green">123</FONT>                        document = parseXML(stream);<a name="line.123"></a>
<FONT color="green">124</FONT>                    }<a name="line.124"></a>
<FONT color="green">125</FONT>                    finally {<a name="line.125"></a>
<FONT color="green">126</FONT>                        if (stream != null) {<a name="line.126"></a>
<FONT color="green">127</FONT>                            stream.close();<a name="line.127"></a>
<FONT color="green">128</FONT>                        }<a name="line.128"></a>
<FONT color="green">129</FONT>                    }<a name="line.129"></a>
<FONT color="green">130</FONT>                }<a name="line.130"></a>
<FONT color="green">131</FONT>                catch (IOException ex) {<a name="line.131"></a>
<FONT color="green">132</FONT>                    throw new JXPathException(<a name="line.132"></a>
<FONT color="green">133</FONT>                        "Cannot read XML from: " + xmlURL.toString(),<a name="line.133"></a>
<FONT color="green">134</FONT>                        ex);<a name="line.134"></a>
<FONT color="green">135</FONT>                }<a name="line.135"></a>
<FONT color="green">136</FONT>            }<a name="line.136"></a>
<FONT color="green">137</FONT>            return document;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /**<a name="line.140"></a>
<FONT color="green">141</FONT>         * Parses XML using the parser for the specified model.<a name="line.141"></a>
<FONT color="green">142</FONT>         * @param stream InputStream<a name="line.142"></a>
<FONT color="green">143</FONT>         * @return Object<a name="line.143"></a>
<FONT color="green">144</FONT>         */<a name="line.144"></a>
<FONT color="green">145</FONT>        public Object parseXML(InputStream stream) {<a name="line.145"></a>
<FONT color="green">146</FONT>            XMLParser parser = getParser(model);<a name="line.146"></a>
<FONT color="green">147</FONT>            if (parser instanceof XMLParser2) {<a name="line.147"></a>
<FONT color="green">148</FONT>                XMLParser2 parser2 = (XMLParser2) parser;<a name="line.148"></a>
<FONT color="green">149</FONT>                parser2.setValidating(isValidating());<a name="line.149"></a>
<FONT color="green">150</FONT>                parser2.setNamespaceAware(isNamespaceAware());<a name="line.150"></a>
<FONT color="green">151</FONT>                parser2.setIgnoringElementContentWhitespace(<a name="line.151"></a>
<FONT color="green">152</FONT>                        isIgnoringElementContentWhitespace());<a name="line.152"></a>
<FONT color="green">153</FONT>                parser2.setExpandEntityReferences(isExpandEntityReferences());<a name="line.153"></a>
<FONT color="green">154</FONT>                parser2.setIgnoringComments(isIgnoringComments());<a name="line.154"></a>
<FONT color="green">155</FONT>                parser2.setCoalescing(isCoalescing());<a name="line.155"></a>
<FONT color="green">156</FONT>            }<a name="line.156"></a>
<FONT color="green">157</FONT>            return parser.parseXML(stream);<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>        /**<a name="line.160"></a>
<FONT color="green">161</FONT>         * Throws an UnsupportedOperationException.<a name="line.161"></a>
<FONT color="green">162</FONT>         * @param value value (not) to set<a name="line.162"></a>
<FONT color="green">163</FONT>         */<a name="line.163"></a>
<FONT color="green">164</FONT>        public void setValue(Object value) {<a name="line.164"></a>
<FONT color="green">165</FONT>            throw new UnsupportedOperationException();<a name="line.165"></a>
<FONT color="green">166</FONT>        }<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>        /**<a name="line.168"></a>
<FONT color="green">169</FONT>         * Maps a model type to a parser.<a name="line.169"></a>
<FONT color="green">170</FONT>         * @param model input model type<a name="line.170"></a>
<FONT color="green">171</FONT>         * @return XMLParser<a name="line.171"></a>
<FONT color="green">172</FONT>         */<a name="line.172"></a>
<FONT color="green">173</FONT>        private static XMLParser getParser(String model) {<a name="line.173"></a>
<FONT color="green">174</FONT>            XMLParser parser = (XMLParser) parsers.get(model);<a name="line.174"></a>
<FONT color="green">175</FONT>            if (parser == null) {<a name="line.175"></a>
<FONT color="green">176</FONT>                String className = (String) parserClasses.get(model);<a name="line.176"></a>
<FONT color="green">177</FONT>                if (className == null) {<a name="line.177"></a>
<FONT color="green">178</FONT>                    throw new JXPathException("Unsupported XML model: " + model);<a name="line.178"></a>
<FONT color="green">179</FONT>                }<a name="line.179"></a>
<FONT color="green">180</FONT>                try {<a name="line.180"></a>
<FONT color="green">181</FONT>                    Class clazz = Class.forName(className);<a name="line.181"></a>
<FONT color="green">182</FONT>                    parser = (XMLParser) clazz.newInstance();<a name="line.182"></a>
<FONT color="green">183</FONT>                }<a name="line.183"></a>
<FONT color="green">184</FONT>                catch (Exception ex) {<a name="line.184"></a>
<FONT color="green">185</FONT>                    throw new JXPathException(<a name="line.185"></a>
<FONT color="green">186</FONT>                        "Cannot allocate XMLParser: " + className, ex);<a name="line.186"></a>
<FONT color="green">187</FONT>                }<a name="line.187"></a>
<FONT color="green">188</FONT>                parsers.put(model, parser);<a name="line.188"></a>
<FONT color="green">189</FONT>            }<a name="line.189"></a>
<FONT color="green">190</FONT>            return parser;<a name="line.190"></a>
<FONT color="green">191</FONT>        }<a name="line.191"></a>
<FONT color="green">192</FONT>    }<a name="line.192"></a>




























































</PRE>
</BODY>
</HTML>
